home *** CD-ROM | disk | FTP | other *** search
/ Hollywood Studio Amiga / Hollywood Studio - Amiga.iso / gfxmanager / docs / ppmtoilbm.man < prev    next >
Text File  |  1995-01-23  |  9KB  |  331 lines
  1.  
  2.  
  3.  
  4.      ppmtoilbm(1)         AMIGA (23 October 1994)         ppmtoilbm(1)
  5.  
  6.  
  7.  
  8.      NAME
  9.           ppmtoilbm - convert a portable pixmap into an IFF-ILBM,
  10.           IFF-RGBN or IFF-RGB8 file
  11.  
  12.      SYNOPSIS
  13.           ppmtoilbm [-ilbm|-rgb8|-rgbn [-ecs|-aga] [-ham6|-ham8]
  14.           [-maxplanes|-mp N] [-fixplanes|-fp N]
  15.           [-normal|-hamif|-hamforce [-hambits|-hamplanes N]
  16.           [-deepbits|-deepplanes N] [-hires] [-lace] [-camg hexval]
  17.           [-floyd|-fs] [-nocompress] [-cmethod method] [-mapfile
  18.           ppmfile] [-sortcmap] [-mmethod method] [-maskfile pbmfile]
  19.           [-transparent color] [ppmfile]
  20.  
  21.      DESCRIPTION
  22.           Reads a portable pixmap as input.  Produces an IFF-ILBM,
  23.           IFF-RGB8 or IFF-RGBN file as output.  Supported ILBM types
  24.           are:
  25.  
  26.           Normal ILBMs
  27.                1-16 planes, with colormap.  Amiga display mode Hold-
  28.                any-modify (HAM) is supported, with 3-10 planes
  29.                (including the 2 control planes).
  30.  
  31.           Deep ILBMs
  32.                3-48 planes, direct RGB encoding. Usually 24 planes are
  33.                used (for 8-bit RGB values).
  34.  
  35.           Colormap files
  36.                BMHD + CMAP chunk only, 0 planes.
  37.  
  38.  
  39.      OPTIONS
  40.           Options marked with (*) can be prefixed with a "no", e.g.
  41.           '-nohamif'.  Most options can only be used for IFF-ILBM
  42.           files, if an option is usable with IFF-RGBN and IFF-RGB8 it
  43.           is noted in the description.  All options can be abbreviated
  44.           to their shortest unique prefix.
  45.  
  46.  
  47.           -ilbm | -rgb8 | -rgbn
  48.                Write an IFF-ILBM, IFF-RGB8 or IFF-RGBN file. The
  49.                default is IFF-ILBM.
  50.  
  51.  
  52.           -maxplanes N
  53.                Maximum planes to write in a normal ILBM.  If the
  54.                pixmap does not fit into N planes, writes a HAM file
  55.                (if -hamif is used), 24bit file (if -24if is used) or
  56.                aborts with an error.  The default value is 5 planes
  57.                (for backwards compatibility), minimum value is 1 and
  58.                maximum 8.  This option can be abbreviated to -mp.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 1/23/95)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      ppmtoilbm(1)         AMIGA (23 October 1994)         ppmtoilbm(1)
  71.  
  72.  
  73.  
  74.           -fixplanes N
  75.                If a normal ILBM is written, it will have exactly N
  76.                planes, even if the number of colors would fit into
  77.                fewer planes. This option can be abbreviated to -fp.
  78.  
  79.  
  80.           -hamplanes N
  81.                Set the number of planes (including the two control
  82.                planes) for a HAM picture.  The current Amiga hardware
  83.                supports 6 and 8 planes, so for now you should use only
  84.                these values.  The default value is 6 (for backwards
  85.                compatibility), minimum value is 3, maximum 10.
  86.  
  87.  
  88.           -hambits N
  89.                Set the number of bits for a color component or index
  90.                value in a HAM picture.  This is the same as
  91.                -hamplanesN+2
  92.  
  93.  
  94.           -deepplanes N
  95.                Set the number of planes for a deep ILBM.  N must be
  96.                divisible by 3.
  97.  
  98.  
  99.           -deepbits N
  100.                Set the number of bits for a color component in a deep
  101.                ILBM.  This is the same as -deepplanes3*N
  102.  
  103.  
  104.           -normal
  105.                Turns off -hamif, -24if, -hamforce, -24force, -deepif,
  106.                -deepforce and -cmaponly and sets compression type to
  107.                byterun1. This is the default mode for IFF-ILBM files.
  108.  
  109.  
  110.           -hamif (*) | -24if (*)
  111.                Write a HAM or 24bit file if the pixmap does not fit
  112.                into the maximum number of planes as given by the
  113.                -maxplanes option.
  114.  
  115.  
  116.           -hamforce (*) | -24force (*)
  117.                Write a HAM or 24bit file.
  118.  
  119.  
  120.           -cmaponly
  121.                Write a colormap file: only BMHD and CMAP chunks, no
  122.                BODY chunk, nPlanes = 0.
  123.  
  124.  
  125.           -ecs | -aga
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 1/23/95)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      ppmtoilbm(1)         AMIGA (23 October 1994)         ppmtoilbm(1)
  137.  
  138.  
  139.  
  140.                Set the appropriate -hamplanes and -maxplanes values
  141.                for the Amiga ECS or AGA chipset.  ECS values are used
  142.                by default for backwards compatibility.
  143.  
  144.  
  145.           -ham6 | -ham8
  146.                Write a HAM picture with 6/8 planes.
  147.  
  148.  
  149.           -hires (*), -lace (*)
  150.                Sets the HIRES and LACE bits in the CAMG chunk and
  151.                adjusts BMHD.xAspect/BMHD.yAspect accordingly. Other
  152.                bits might be set in the CAMG chunk depending on other
  153.                options.  These options can be used with IFF-RGBN and
  154.                IFF-RGB8 files.
  155.  
  156.  
  157.           -camg hexval
  158.                Write a specific value into the CAMG chunk.  The
  159.                hexadecimal value can be given with or without a 0x
  160.                prefix. Other bits might be set in the CAMG chunk
  161.                depending on other options.  This option can be used
  162.                with IFF-RGBN and IFF-RGB8 files.
  163.  
  164.  
  165.           -nocompress
  166.                Do not compress the BODY chunk.  Compression requires
  167.                building the ILBM image in memory; turning compression
  168.                off allows stream-writing of the image, but the
  169.                resulting file will usually be 30% to 50% larger. This
  170.                options affect only IFF-ILBM files, IFF-RGBN and IFF-
  171.                RGB8 files are always compressed using a pixel repeat
  172.                count.
  173.  
  174.  
  175.           -cmethod method
  176.                Select compression method.  Default is byterun1.
  177.                Setting method to none is equivalent to using a
  178.                -nocompress option.  method can be abbreviated to the
  179.                shortest unique prefix.
  180.  
  181.  
  182.           -mapfile ppmfile
  183.                Use the colors in ppmfile as the colormap when writing
  184.                a normal ILBM.  The mapfile is a normal PPM image, it
  185.                can be any shape, all that matters are the colors in
  186.                it, and the order they appear in.  If the colors in the
  187.                input file do not match those in ppmfile , they are
  188.                matched to a "best match".
  189.  
  190.  
  191.           -sortcmap
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 1/23/95)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      ppmtoilbm(1)         AMIGA (23 October 1994)         ppmtoilbm(1)
  203.  
  204.  
  205.  
  206.                Sort the colormap.
  207.  
  208.  
  209.           -mmethod method
  210.                Select masking method.  method can be none
  211.                 (no masking, default), maskplane and transparentcolor
  212.                 (only for normal ILBMs).  lasso masks are are not
  213.                supported yet.  method can be abbreviated to the
  214.                shortest unique prefix.
  215.  
  216.  
  217.           -maskfile pbmfile
  218.                Use a mask file to mark transparent pixels in an IFF-
  219.                ILBM.  If the -mmethod option is not used, masking
  220.                method is set to maskplane. pbmfile is a normal PBM
  221.                image, the same size (or larger) as the input file.  A
  222.                pixel value of PBM_WHITE in the mask file means the
  223.                corresponding in the input file is considered to be
  224.                transparent, PBM_BLACK indicates an opaque pixel (think
  225.                of the input file casting a shadow on a white screen).
  226.                In an IFF-RGBN or IFF-RGB8 file, the mask file is used
  227.                to set the genlock bits.
  228.  
  229.  
  230.           -transparent color
  231.                Mark the given color as transparent.  The color is
  232.                specified as in ppmmake(1).  If the -mmethod options is
  233.                not used, masking method is set to transparentcolor.
  234.  
  235.  
  236.           -floyd (*) | -fs (*)
  237.                Use Floyd-Steinberg error diffusion for mapping the
  238.                input colors to HAM or to the colors in a mapfile.  The
  239.                results are usually much better than without it, but it
  240.                takes substantially more CPU time, so the default is
  241.                off.
  242.  
  243.  
  244.      BUGS
  245.           HAM pictures will always get a grayscale colormap; a real
  246.           color selection algorithm might give better results.  On the
  247.           other hand, this allows row-by-row operation on HAM images,
  248.           and all HAM images of the same depth (no.  of planes) share
  249.           a common colormap, which is useful for building HAM
  250.           animations.
  251.           Not all IFF-ILBM types that are supported by can be
  252.           generated with
  253.           The number of options for this program is approaching the
  254.           ls(1)-dangerlevel.
  255.  
  256.  
  257.      REFERENCES
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 1/23/95)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      ppmtoilbm(1)         AMIGA (23 October 1994)         ppmtoilbm(1)
  269.  
  270.  
  271.  
  272.           Amiga ROM Kernel Reference Manual - Devices (3rd Ed.),
  273.           Addison Wesley, ISBN 0-201-56775-X, Appendix A: Interchange
  274.           File Format
  275.  
  276.  
  277.      SEE ALSO
  278.           ppm(5), ilbmtoppm(1)
  279.  
  280.  
  281.      AUTHORS
  282.           Copyright (C) 1989 by Jef Poskanzer.
  283.           Modified 1993/1994 by Ingo Wilken
  284.           (Ingo.Wilken@informatik.uni-oldenburg.de)
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 1/23/95)
  328.  
  329.  
  330.  
  331.